Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

typescript-node: clean up require and import #6947

Conversation

laubfall
Copy link
Contributor

@laubfall laubfall commented Jul 15, 2020

… instead of import statement

PR checklist

  • Read the contribution guidelines.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/config/java*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02)

@macjohnny macjohnny changed the title Typescript node mixes require and import 4656 typescript-node: clean up require and import Jul 15, 2020
Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@macjohnny macjohnny added this to the 5.0.0 milestone Jul 15, 2020
import localVarRequest from 'request';
import http from 'http';
{{/supportsES6}}
{{^supportsES6}}
import localVarRequest = require('request');
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The import var = require does not make much sense to me. This should be probably const localVarRequest = require('request').

Or did I oversee something?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same for the other parts.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah thats right, i'll fix it :)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm getting some typescript errors with const http = require. These are "TS2503: Cannot find namespace 'http'." and "error TS4055: Return type of public method from exported class has or is using private name 'http'.". As described here: https://stackoverflow.com/questions/31173738/typescript-getting-error-ts2304-cannot-find-name-require there are some ways to make this work, but to be honest i don't see a reason why to make a difference at this point. All other modules are imported with the "import .. from" stmt independent of the ES6 flag. So i removed the switch and changed the tsconfig to make the imports http/request work. What do you think about this solution?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For TypeScript to use these you need the types for the Nodejs internal ones. Basically @types/node.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The current solution should be fine.

@DanielRuf
Copy link
Contributor

  • [ x]

You might want to remove the space inside the square brackets (it is either a space or x as single character) ;-)

@macjohnny
Copy link
Member

@laubfall could you please fix the CI issues?

Copy link
Contributor

@DanielRuf DanielRuf left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See my remarks / comments =)

@wing328
Copy link
Member

wing328 commented Jul 28, 2020

Thanks for the PR but your commit (as shown in the Commits tab) is not linked to your Github account, which means this PR won't count as your contribution in https://github.com/OpenAPITools/openapi-generator/graphs/contributors.

Let me know if you need help fixing it.

Ref: https://github.com/OpenAPITools/openapi-generator/wiki/FAQ#how-can-i-update-commits-that-are-not-linked-to-my-github-account

@wing328
Copy link
Member

wing328 commented Jul 28, 2020

I just pushed 547e305 to fix the CI failure. Let's see how that goes.

model/pet.ts
model/tag.ts
model/user.ts
model/./apiResponse.ts
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why this change? ./ makes not much sense in my opinion.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed ./ is not needed. We'll tackle it separately.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, so there is nothing left here to todo for the PR?

@laubfall
Copy link
Contributor Author

laubfall commented Jul 31, 2020

I just pushed 547e305 to fix the CI failure. Let's see how that goes.

Thanks, i looked into the CI Failure but did not saw the reason why the build failed

@wing328
Copy link
Member

wing328 commented Jul 31, 2020

Shippable CI failure not related to this PR.

@wing328 wing328 merged commit b838e18 into OpenAPITools:master Jul 31, 2020
jimschubert added a commit that referenced this pull request Aug 3, 2020
* master: (121 commits)
  [PowerShell] better publishing workflow (#7114)
  [aspnetcore] Typo issues in docs and generated code (#7094)
  fix http signaure auth in build.sbt (#7110)
  fix for the issue facing spec invlolving arrayschema structure with ref (#6310)
  [csharp-netcore] added cancellation tokens to async calls (#7077)
  [PS] Allow CI to publish the module (#7091)
  [Dart] Treat float as double (#6924)
  [Java][jersey2]Fix gradle HttpSignatureAuth dependencies (#7096)
  move maven,gradle tests to shipppable ci (#7108)
  [MARKDOWN] Fix issue 6089 with property and parameter names (#6105)
  [BUG] Multi-Part content type in response ignores properties of composed schema (allOf/oneOf) (#6073)
  [online] Fix for version conflicts with springfox/boot (#7102)
  skip some installations to shorten build time
  [Go][Exp] better code format (#7088)
  Fix Shippable CI (#7097)
  typescript-node: clean up require and import (#6947)
  commented out perl, bash tests to reduce build time
  Add a link to conference paper (#7086)
  Add a link to the blog post at qiita (#7084)
  migrate typescript.sh to new config format (#7078)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] typescript-node mixes require and import
4 participants